FlowMail Properties
An object defining properties for the FlowMail class.
MessageOptions
Gets or sets the message options.
Type: IFlowMessageOptions
NotificationOptions
Gets or sets the push notification options.
Key
A unique identifier for the workflow step.
Type: string
MailMessage
Gets the mail message associated with the message.
Type: Dictionary<string, string>
WorkflowCodeInstance
The workflow code instance associated with the flow object.
Type: IWorkflowCode
CachedDMObjects
The cached document management objects related to the flow object.
Type: IRuntimeDMObjects
NotificationCaption
Gets the notification caption associated with the message.
Type: Dictionary<string, string>
NotificationMessage
Gets the notification message associated with the message.
Type: Dictionary<string, string>
IncludeFlowInitiator
Determines whether to include the workflow initiator in the mail group.
Type: bool
IsCustomMailMessage
Gets or sets a value indicating whether the mail message is custom.
Type: bool
DepartmentBasedUserGroups
A list of department-based user groups included in the workflow mail group.
VariablePositions
A list of variable positions included in the workflow mail group.
Type: List<IMembersVariablePositions>
MailSubject
Gets the mail subject associated with the message.
Type: Dictionary<string, string>
IncludeDocumentApproversOrRefusers
Specifies whether to include document approvers or refusers in the workflow mail group.
Type: bool
EnableSendMail
Gets or sets a value indicating whether sending mail is enabled.
Type: bool
TypeCode
The type code associated with the flow object.
Type: WorkflowItemTypeCode
Accepted Values:
Name Value FlowComment -1 FlowStart 10 FlowEnd 11 FlowPosition 15 FlowAssign 21 FlowCompare 22 FlowOr 24 FlowAnd 25 FlowMail 26 FlowProfession 27 FlowDepartment 28 Variable 30 FlowScript 31 FlowNode 33 FlowGroup 37 FlowTimer 39 FlowTimerStarter 40 FlowTimerStopper 41 FlowApprovalCancellar 42 Pauser 44 SubFlowCall 51 SubFlowBegin 52 SubFlowEnd 53 FlowPushNotification 54 FlowDocument 56 FlowCreateDocument 57 FlowDocumentSynchronizer 58 FlowStarterPosition 59 FlowDocumentState 63 FlowUniqueIdCreator 65 FlowSetDocumentId 66 FlowDeleteDocument 67 FlowPDFExport 68 FlowXMLExport 69 FlowMailSender 75 FlowParallel 79 FlowContinue 80 FlowTrigger 81 FlowActionCreator 82 FlowDigitallySigning 83 FlowGptPrompt 84
Members
Defines the configuration for members in the workflow mail group.
Type: IFlowMembersOptions
Attachments
Gets the list of attachments associated with the message.
Type: IReadOnlyList<string>
WebNotificationOptions
Gets or sets the web notification options.
TableObjects
A list of table objects associated with the workflow mail group.
Type: List<IMembersTableObjects>
Name
Name for the workflow step.
Type: string
DetailObjects
A list of detail objects associated with the workflow mail group.
Type: List<IMembersDetailObjects>
Users
A list of resolved users in the workflow mail group.
UserGroups
A list of user groups included in the workflow mail group.
Type: List<IMembersUserGroups>
Documents
A list of documents associated with the workflow mail group.
EnablePushNotification
Gets or sets a value indicating whether push notification is enabled.
Type: bool
CustomMailMessage
Gets the custom mail message associated with the message.
Type: Dictionary<string, string>
ShowInFlowHistory
Specifies whether this mail step should appear in the workflow history.
Type: bool
Caption
The caption dictionary representing localized captions for the flow object.
Type: Dictionary<string, string>
ConstantPositions
A list of constant positions included in the workflow mail group.
Type: List<IMembersConstantPositions>